/********************************
 * ETK - Easy ToolKit
 * Copyright (C) 2007-2008 Ekinoks (scv.ekinoks@gmail.com)
 * All rights reserved.
 *
 *    This file is part of ETK.
 *
 *    Foobar is free software; you can redistribute it and/or modify
 *    it under the terms of the GNU General Public License as published by
 *    the Free Software Foundation; either version 2 of the License, or
 *    (at your option) any later version.
 *
 *    Foobar is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *    GNU General Public License for more details.
 *
 *    You should have received a copy of the GNU General Public License
 *    along with Foobar; if not, write to the Free Software
 *    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 ***********************************************************************************/

#ifndef __ETK_SHUTTERKEYMODEL_H__
#define __ETK_SHUTTERKEYMODEL_H__

#include <string>

namespace etk
{
    class ShutterKey;

    class ShutterKeyModel
    {
        private :
            friend class ToolKit;       // TODO : mettre juste pour ToolKit::setCharacter et ToolKit::setKeyCode
            friend class EventKey;

            // utiliser des vector pour "keycode_" et "character_" si l'on souhaite redéfinir l'operateur ||

            short int keyCode_;  // raw code (les meme que ceux de GTK) (0 pour n'importe)

            std::string characters_;      // vide pour n'importe

        protected :

            ShutterKeyModel(short int keyCode, std::string characters) : keyCode_(keyCode), characters_(characters)
            {

            }

        public :

            ShutterKeyModel(std::string characters) : keyCode_(0), characters_(characters)
            {

            }

            ShutterKeyModel(short int keyCode) : keyCode_(keyCode)
            {

            }

            short int getKeyCode() const
            {
                return keyCode_;
            }

            std::string getCharacters() const
            {
                return characters_;
            }

            bool operator== (const ShutterKey& shutterKey) const;
            bool operator!= (const ShutterKey& shutterKey) const;

            bool operator== (const ShutterKeyModel& shutterKeyModel) const;
            bool operator!= (const ShutterKeyModel& shutterKeyModel) const;

            static const ShutterKeyModel ANY;
    };
}

#endif // __ETK_SHUTTERKEYMODEL_H__
